[PB Generic表][Go SDK]批量插入多条数据
1. 接口说明
BatchInsert，向数据库表中批量插入多条记录
注意：
- 最多批量操作1024条记录;
- 单条记录的错误码在调用response的FetchRecord时返回
- 调用request的方法SetMultiResponseFlag()设置允许分包，否则，响应包超过256KB不分包会丢包
- 当响应包超过256KB会触发分包。但保证分包不会切分单个记录（不管这个记录多大），例如，响应包的3个记录分别是10KB、251KB、1MB，会分为2个包返回，即(10KB、251KB)和(1MB); 可调用TcaplusServiceResponse::HaveMoreResPkgs()判断是否还有下一个包
更多说明参见批量操作接口的相关说明。
2. 版本要求
3.55.0以上版本SDK
3. 准备工作
参见准备工作文档，完成使用该接口前的准备工作，并创建如下PB Generic表。game_players表
syntax = "proto3"; // Specify the version of the protocol buffers language
package tcaplusservice;
import "tcaplusservice.optionv1.proto"; // Use the public definitions of TcaplusDB by importing them.
message game_players { // Define a TcaplusDB table with message
// Specify the primary keys with the option tcaplusservice.tcaplus_primary_key
// The primary key of a TcaplusDB table has a limit of 4 fields
option(tcaplusservice.tcaplus_primary_key) = "player_id, player_name, player_email";
// Specify the primary key indexes with the option tcaplusservice.tcaplus_index
option(tcaplusservice.tcaplus_index) = "index_1(player_id, player_name)";
option(tcaplusservice.tcaplus_index) = "index_2(player_id, player_email)";
// Value Types supported by TcaplusDB
// int32, int64, uint32, uint64, sint32, sint64, bool, fixed64, sfixed64, double, fixed32, sfixed32, float, string, bytes
// Nested Types Message
// primary key fields
int64 player_id = 1;
string player_name = 2;
string player_email = 3;
// Ordinary fields
int32 game_server_id = 4;
repeated string login_timestamp = 5;
repeated string logout_timestamp = 6;
bool is_online = 7;
payment pay = 8;
}
message payment {
int64 pay_id = 1;
uint64 amount = 2;
int64 method = 3;
}
准备工作完成后，将会获得以下信息，这些信息在使用SDK时会被用到：
- 目录服务器地址列表
- 业务ID
- 业务访问密码
- 游戏区ID
- 数据表名
4. 示例代码
示例代码的基本执行过程：
- 定义表配置参数
- 设置日志配置；
- 创建客户端；
- 发送请求并处理响应；
- 销毁客户端。
客户端初始化示例：
package main
import (
"fmt"
"git.woa.com/gcloud_storage_group/tcaplus-go-api"
)
// 定义表配置参数
const (
AppId = uint64(2)
ZoneId = uint32(3)
DirUrl = "tcp://x.x.x.x:xxxx"
Signature = "xxxxxxxxxxxxx"
TableName = "game_players"
)
var client *tcaplus.PBClient
func main() {
// 创建客户端
client = tcaplus.NewPBClient()
// 设置日志配置，logconf.xml文件设置了日志级别
if err := client.SetLogCfg("./logconf.xml"); err != nil {
fmt.Println(err.Error())
return
}
//构造Map对象存储对应表格组下所有的表
zoneList := []uint32{ZoneId}
zoneTable := make(map[uint32][]string)
zoneTable[ZoneId] = []string{TableName}
// 连接TcaplusDB后端
err := client.Dial(AppId, zoneList, DirUrl, Signature, 30, zoneTable)
if err != nil {
fmt.Printf("init failed %v\n", err.Error())
return
}
// 设置默认使用的zone
client.SetDefaultZoneId(ZoneId)
fmt.Printf("Dial finish\n")
BatchInsertExample()
// 程序退出时调用Close销毁客户端
client.Close()
}
4.1 同步调用示例
同步调用编码最简单，通过多协程并发 示例目录
package main
import (
"fmt"
"git.woa.com/gcloud_storage_group/tcaplus-go-api/example/PB/table/tcaplusservice"
"google.golang.org/protobuf/proto"
"time"
)
func BatchInsertExample() {
//batch insert 10 data
var msgs []proto.Message
id := time.Now().UnixNano()
for i := 0; i < 10; i++ {
data := &tcaplusservice.GamePlayers{}
data.PlayerId = id
data.PlayerName = "batchInsert"
data.PlayerEmail = fmt.Sprintf("%d", i)
data.Pay = &tcaplusservice.Payment{Amount: uint64(i), PayId: 2, Method: 3}
msgs = append(msgs, data)
}
err := client.DoBatchInsert(msgs, nil)
if err != nil {
fmt.Println(err.Error())
return
}
fmt.Println("DoBatchInsert success")
}
4.2 同步调用示例2
该示例同步调用方式比较类似C++接口的调用方式，需要创建请求和解析响应示例目录
package main
import (
"fmt"
"git.woa.com/gcloud_storage_group/tcaplus-go-api/example/PB/table/tcaplusservice"
"git.woa.com/gcloud_storage_group/tcaplus-go-api/example/PB/tools"
"git.woa.com/gcloud_storage_group/tcaplus-go-api/logger"
"git.woa.com/gcloud_storage_group/tcaplus-go-api/protocol/cmd"
"git.woa.com/gcloud_storage_group/tcaplus-go-api/terror"
"time"
)
package main
import (
"fmt"
"git.woa.com/gcloud_storage_group/tcaplus-go-api/example/PB/table/tcaplusservice"
"git.woa.com/gcloud_storage_group/tcaplus-go-api/example/PB/tools"
"git.woa.com/gcloud_storage_group/tcaplus-go-api/logger"
"git.woa.com/gcloud_storage_group/tcaplus-go-api/protocol/cmd"
"git.woa.com/gcloud_storage_group/tcaplus-go-api/terror"
"time"
)
func BatchInsertExample() {
// 生成 batch 请求
req, err := client.NewRequest(tools.Zone, "game_players", cmd.TcaplusApiBatchInsertReq)
if err != nil {
logger.ERR("NewRequest error:%s", err)
return
}
// 设置分包
req.SetMultiResponseFlag(1)
// 向请求中添加记录，对于 generic 表 index 无意义，填 0 即可
record1, err := req.AddRecord(0)
if err != nil {
logger.ERR("AddRecord error:%s", err)
return
}
// 向记录中填充数据
msg1 := &tcaplusservice.GamePlayers{
PlayerId: 10805515,
PlayerName: "Calvin1",
PlayerEmail: "calvin@test.com",
GameServerId: 10,
LoginTimestamp: []string{"2019-12-12 15:00:00"},
LogoutTimestamp: []string{"2019-12-12 16:00:00"},
IsOnline: false,
Pay: &tcaplusservice.Payment{
PayId: 10101,
Amount: 1000,
Method: 1,
},
}
// 第一个返回值为记录的keybuf，用来唯一确定一条记录，多用于请求与响应记录相对应，此处无用
_, err = record1.SetPBData(msg1)
if err != nil {
logger.ERR("SetPBData error:%s", err)
return
}
// 向请求中添加记录，对于 generic 表 index 无意义，填 0 即可
record2, err := req.AddRecord(0)
if err != nil {
logger.ERR("AddRecord error:%s", err)
return
}
// 向记录中填充数据
msg2 := &tcaplusservice.GamePlayers{
PlayerId: 10805515,
PlayerName: "Calvin2",
PlayerEmail: "calvin@test.com",
GameServerId: 10,
LoginTimestamp: []string{"2019-12-12 15:00:00"},
LogoutTimestamp: []string{"2019-12-12 16:00:00"},
IsOnline: false,
Pay: &tcaplusservice.Payment{
PayId: 10101,
Amount: 1000,
Method: 1,
},
}
// 第一个返回值为记录的keybuf，用来唯一确定一条记录，多用于请求与响应记录相对应，此处无用
_, err = record2.SetPBData(msg2)
if err != nil {
logger.ERR("SetPBData error:%s", err)
return
}
// 发送请求,接收响应
resps, err := client.DoMore(req, 5*time.Second)
if err != nil {
logger.ERR("SendRequest error:%s", err)
return
}
for _, resp := range resps {
// 获取响应结果
errCode := resp.GetResult()
if errCode != terror.GEN_ERR_SUC {
logger.ERR("insert error:%s", terror.GetErrMsg(errCode))
return
}
// 如果有返回记录则用以下接口进行获取
for i := 0; i < resp.GetRecordCount(); i++ {
record, err := resp.FetchRecord()
if err != nil {
logger.ERR("FetchRecord failed %s", err.Error())
return
}
newMsg := &tcaplusservice.GamePlayers{}
err = record.GetPBData(newMsg)
if err != nil {
logger.ERR("GetPBData failed %s", err.Error())
return
}
fmt.Println(tools.ConvertToJson(newMsg))
}
}
logger.INFO("batch success")
fmt.Println("batch success")
}
4.2 异步调用示例
异步发送可以使用较少的协程实现较大的并发，编码相对复杂，示例目录
package main
import (
"fmt"
"git.woa.com/gcloud_storage_group/tcaplus-go-api/example/PB/table/tcaplusservice"
"git.woa.com/gcloud_storage_group/tcaplus-go-api/example/PB/tools"
"git.woa.com/gcloud_storage_group/tcaplus-go-api/logger"
"git.woa.com/gcloud_storage_group/tcaplus-go-api/protocol/cmd"
"git.woa.com/gcloud_storage_group/tcaplus-go-api/terror"
"sync"
"time"
)
func BatchInsertExample() {
wg := sync.WaitGroup{}
wg.Add(1)
// 在另一协程处理响应消息
go func() {
defer wg.Done()
for {
// resp err 均为 nil 说明响应池中没有任何响应
resp, err := client.RecvResponse()
if err != nil {
logger.ERR("RecvResponse error:%s", err)
continue
} else if resp == nil {
time.Sleep(time.Microsecond * 5)
continue
}
// 获取响应结果
errCode := resp.GetResult()
if errCode != terror.GEN_ERR_SUC {
logger.ERR("insert error:%s", terror.GetErrMsg(errCode))
return
}
// 如果有返回记录则用以下接口进行获取
for i := 0; i < resp.GetRecordCount(); i++ {
record, err := resp.FetchRecord()
if err != nil {
logger.ERR("FetchRecord failed %s", err.Error())
return
}
newMsg := &tcaplusservice.GamePlayers{}
err = record.GetPBData(newMsg)
if err != nil {
logger.ERR("GetPBData failed %s", err.Error())
return
}
fmt.Println(tools.ConvertToJson(newMsg))
}
//判断是否有分包
if 1 == resp.HaveMoreResPkgs() {
continue
}
return
}
}()
// 生成 batch 请求
req, err := client.NewRequest(tools.ZoneId, "game_players", cmd.TcaplusApiBatchInsertReq)
if err != nil {
logger.ERR("NewRequest error:%s", err)
return
}
// 向请求中添加记录，对于 generic 表 index 无意义，填 0 即可
record1, err := req.AddRecord(0)
if err != nil {
logger.ERR("AddRecord error:%s", err)
return
}
// 向记录中填充数据
msg1 := &tcaplusservice.GamePlayers{
PlayerId: 10805515,
PlayerName: "Calvin1",
PlayerEmail: "calvin@test.com",
GameServerId: 10,
LoginTimestamp: []string{"2019-12-12 15:00:00"},
LogoutTimestamp: []string{"2019-12-12 16:00:00"},
IsOnline: false,
Pay: &tcaplusservice.Payment{
PayId: 10101,
Amount: 1000,
Method: 1,
},
}
// 第一个返回值为记录的keybuf，用来唯一确定一条记录，多用于请求与响应记录相对应，此处无用
_, err = record1.SetPBData(msg1)
if err != nil {
logger.ERR("SetPBData error:%s", err)
return
}
// 向请求中添加记录，对于 generic 表 index 无意义，填 0 即可
record2, err := req.AddRecord(0)
if err != nil {
logger.ERR("AddRecord error:%s", err)
return
}
// 向记录中填充数据
msg2 := &tcaplusservice.GamePlayers{
PlayerId: 10805515,
PlayerName: "Calvin2",
PlayerEmail: "calvin@test.com",
GameServerId: 10,
LoginTimestamp: []string{"2019-12-12 15:00:00"},
LogoutTimestamp: []string{"2019-12-12 16:00:00"},
IsOnline: false,
Pay: &tcaplusservice.Payment{
PayId: 10101,
Amount: 1000,
Method: 1,
},
}
// 第一个返回值为记录的keybuf，用来唯一确定一条记录，多用于请求与响应记录相对应，此处无用
_, err = record2.SetPBData(msg2)
if err != nil {
logger.ERR("SetPBData error:%s", err)
return
}
// （非必须）设置 异步 id
req.SetAsyncId(12345)
// 设置分包
req.SetMultiResponseFlag(1)
// 发送请求
err = client.SendRequest(req)
if err != nil {
logger.ERR("SendRequest error:%s", err)
return
}
wg.Wait()
logger.INFO("batch success")
fmt.Println("batch success")
}
5. 请求对象(request)中的方法说明
注：此处未列出请求对象的其它方法，即表示该方法在查询数据的场景不需要使用，误用可能会导致报错。
/**
@brief 向请求中添加一条记录。
@param [IN] index 用于List操作,通常>=0，表示该Record在所属List中的Index；
对于Generic操作，index无意义，设0即可
@retval record.Record 返回记录指针
@retval error 错误码
**/
AddRecord(index int32) (*record.Record, error)
/**
@brief 设置请求的异步事务ID，api会将其值不变地通过对应的响应消息带回来
@param [IN] asyncId 请求对应的异步事务ID
**/
SetAsyncId(id uint64)
/**
@brief 设置请求的通用标志位，可以通过"按位或"操作同时设定多个值
@param [IN] flag. 请求标志位的值
@retval 0 设置成功
@retval <0 失败，返回对应的错误码。通常因为未初始化。
@note 有效的标志位包括：
* TCAPLUS_FLAG_FETCH_ONLY_IF_MODIFIED:
* "数据变更才取回"标志位。在发起读操作之前，用户代码通过 TcaplusServiceRecord::SetVersion()
* 带上本地缓存数据的版本号，并将此标志置位，那么存储端检测到当前数据与API本地缓存的数据版本
* 一致时，表明该记录未发生过修改，API缓存的数据是最新的，因此在响应中将不会携带实际的数据，
* 只是返回 TcapErrCode::COMMON_INFO_DATA_NOT_MODIFIED 的错误码
*
* 在请求中设置了此标志位之后，收到响应后应首先通过 TcaplusServiceResponse::GetFlags() 来获知
* 发送请求时是否设置了TCAPLUS_FLAG_FETCH_ONLY_IF_MODIFIED标志.
*
* 只有如下请求支持设置此标志：
* TCAPLUS_API_GET_REQ,
* TCAPLUS_API_LIST_GET_REQ,
* TCAPLUS_API_LIST_GETALL_REQ
*
* TCAPLUS_FLAG_FETCH_ONLY_IF_EXPIRED:
* "数据过期才取回"标志位。在发起读操作之前，用户代码通过 SetExpireTime() 设定数据过期时间，
* 并将此标志置位，那么存储端若检测到记录在指定时间内发生过更新，则将数据返回，
* 否则不返回实际数据，只是返回 TcapErrCode::COMMON_INFO_DATA_NOT_MODIFIED 的错误码。
*
* 在请求中设置了此标志位之后，收到响应后应首先通过 TcaplusServiceResponse::GetFlags() 来获知
* 发送请求时是否设置了 TCAPLUS_FLAG_FETCH_ONLY_IF_EXPIRED 标志.
*
* 只有如下请求支持设置此标志：
* TCAPLUS_API_BATCH_GET_REQ
*
* TCAPLUS_FLAG_ONLY_READ_FROM_SLAVE
* 设置此标志后，读请求将会直接发送给Tcapsvr Slave 节点。
* Tcapsvr Slave 通常比较空闲，设置此标志有助于充分利用Tcapsvr Slave 资源。
*
* 适用场景:
* 对于数据实时性要求不高的读请求，
* 包括generic表和list表的所有读请求以及batchget，遍历请求
*
* TCAPLUS_FLAG_LIST_RESERVE_INDEX_HAVING_NO_ELEMENTS
* 设置此标志后，List表删除最后一个元素时需要保留index和version。
* ListDelete ListDeleteBatch ListDeleteAll操作在删除list表最后一个元素时，
* 设置此标志在写入新的List记录时，版本号依次增长，不会被重置为1。
*
* 适用场景:
* 业务需要确定某个表在删除最后一个元素时是否需要保留index和version
* 主要涉及List表的使用体验
*
*/
SetFlags(flag int32) int
/**
@brief 清理请求的通用标志位，可以通过"按位或"操作同时设定多个值
@param [IN] flag. 请求标志位的值
@retval 0 设置成功
@retval <0 失败，返回对应的错误码。通常因为未初始化。
@note 有效的标志位列表及详细解释请参考 SetFlags()
*/
ClearFlags(flag int32) int
/**
@brief 获取请求的通用标志位
@return 返回请求的通用标志位
@note 有效的标志位列表及详细解释请参考 SetFlags()
*/
GetFlags() int32
/**
@brief 设置需要查询或更新的Value字段名称列表，即部分Value字段查询和更新，可用于get、replace、update操作。
@param [IN] valueNameList 需要查询或更新的字段名称列表
@retval error 错误码
@note 在使用该函数设置字段名时，字段名只能包含value字段名，不能包含key字段名；对于数组类型的字段，
refer字段和数组字段要同时设置或者同时不设置，否则容易数据错乱
**/
SetFieldNames(valueNameList []string) error
/**
@brief 设置用户缓存，响应消息将携带返回
@param [IN] userBuffer 用户缓存
@retval error 错误码
**/
SetUserBuff(userBuffer []byte) error
/**
@brief 设置记录版本的检查类型，用于乐观锁
@param [IN] type 版本检测类型，取值可以为:
CheckDataVersionAutoIncrease: 表示检测记录版本号，只有当record.SetVersion函数传入的参数
version的值>0,并且版本号与服务器端的版本号相同时，请求才会成功同时在服务器端该版本号会自增1；
如果record.SetVersion的version <=0，则仍然表示不关心版本号
NoCheckDataVersionOverwrite: 表示不检测记录版本号。
当record.SetVersion函数传入的参数version的值>0,覆盖服务端的版本号；
如果record.SetVersion的version <=0，则仍然表示不关心版本号
NoCheckDataVersionAutoIncrease: 表示不检测记录版本号，将服务器端的数据记录版本号自增1，
若服务器端新写入数据记录则新写入的数据记录的版本号为1
@retval error 错误码
@note 此函数适合Replace, Update操作
**/
SetVersionPolicy(p uint8) error
/**
@brief 设置响应标志。主要用于Generic表的insert、increase、replace、update、delete操作。
@param [IN] flag 请求标志:
0表示: 只需返回操作执行成功与否
1表示: 操作成功，响应返回与请求字段一致
2表示: 操作成功，响应返回变更记录的所有字段最新数据
3表示: 操作成功，响应返回变更记录的所有字段旧数据
@retval error 错误码
NOTE：SetResultFlag有历史包袱，某些场景并不准确，推荐使用SetResultFlagForSuccess
**/
SetResultFlag(flag int) error
/**
@brief 设置响应标志。主要是本次请求成功执行后返回给前端的数据
result_flag 的取值范围如下:
TCaplusValueFlag_NOVALUE = 0, // 不返回任何返回值
TCaplusValueFlag_SAMEWITHREQUEST = 1, // 返回同请求一致的值
TCaplusValueFlag_ALLVALUE = 2, // 返回tcapsvr端操作后所有字段的值
TCaplusValueFlag_ALLOLDVALUE = 3, // 返回tcapsvr端操作前所有字段的值
下面是各个支持的命令字在设置不同的result_flag下执行成功后返回给API端的数据详细情况:
1. TCAPLUS_API_INSERT_REQ TCAPLUS_API_BATCH_INSERT_REQ
如果设置的是TCaplusValueFlag_NOVALUE, 则操作成功后不返回数据
如果设置的是TCaplusValueFlag_SAMEWITHREQUEST, 则操作成功后返回和请求一致的数据
如果设置的是TCaplusValueFlag_ALLVALUE, 则操作成功后返回本次insert操作后的数据
如果设置的是TCaplusValueFlag_ALLOLDVALUE, 则操作成功后返回空数据
2. TCAPLUS_API_REPLACE_REQ TCAPLUS_API_BATCH_REPLACE_REQ
如果设置的是TCaplusValueFlag_NOVALUE, 则操作成功后不返回数据
如果设置的是TCaplusValueFlag_SAMEWITHREQUEST, 则操作成功后返回和请求一致的数据
如果设置的是TCaplusValueFlag_ALLVALUE, 则操作成功后返回本次replace操作后的数据
如果设置的是TCaplusValueFlag_ALLOLDVALUE, 则操作成功后返回tcapsvr端操作前的数据, 如果tcapsvr端没有数据,即返回为空
3. TCAPLUS_API_UPDATE_REQ TCAPLUS_API_BATCH_UPDATE_REQ
如果设置的是TCaplusValueFlag_NOVALUE, 则操作成功后不返回数据
如果设置的是TCaplusValueFlag_SAMEWITHREQUEST, 则操作成功后返回和请求一致的数据
如果设置的是TCaplusValueFlag_ALLVALUE, 则操作成功后返回本次update操作后的数据
如果设置的是TCaplusValueFlag_ALLOLDVALUE, 则操作成功后返回tcapsvr端操作前的数据
4. TCAPLUS_API_INCREASE_REQ
如果设置的是TCaplusValueFlag_NOVALUE, 则操作成功后不返回数据
如果设置的是TCaplusValueFlag_SAMEWITHREQUEST, 则操作成功后返回和请求一致的数据
如果设置的是TCaplusValueFlag_ALLVALUE, 则操作成功后返回本次increase操作后的数据
如果设置的是TCaplusValueFlag_ALLOLDVALUE, 则操作成功后返回tcapsvr端操作前的数据, 如果tcapsvr端没有数据,即返回为空
5. TCAPLUS_API_DELETE_REQ TCAPLUS_API_BATCH_DELETE_REQ
如果设置的是TCaplusValueFlag_NOVALUE, 则操作成功后不返回数据
如果设置的是TCaplusValueFlag_SAMEWITHREQUEST, 则操作成功后返回和请求一致的数据
如果设置的是TCaplusValueFlag_ALLVALUE, 则操作成功后返回空数据
如果设置的是TCaplusValueFlag_ALLOLDVALUE, 则操作成功后返回tcapsvr端操作前的数据
6. TCAPLUS_API_LIST_DELETE_BATCH_REQ
如果设置的是TCaplusValueFlag_NOVALUE, 则操作成功后不返回数据
如果设置的是TCaplusValueFlag_SAMEWITHREQUEST, 则操作成功后返回和请求一致的数据, 暂时没有实现
如果设置的是TCaplusValueFlag_ALLVALUE, 则操作成功后不返回数据
如果设置的是TCaplusValueFlag_ALLOLDVALUE, 则操作成功后返回tcapsvr端操作前的数据, 凡是本次成功删除的index对应的数据都会返回
7. TCAPLUS_API_LIST_ADDAFTER_REQ
如果设置的是TCaplusValueFlag_NOVALUE, 则操作成功后不返回数据
如果设置的是TCaplusValueFlag_SAMEWITHREQUEST, 则操作成功后返回和请求一致的数据, 暂时没有实现
如果设置的是TCaplusValueFlag_ALLVALUE, 则操作成功后, 返回本次插入的记录和本次淘汰的数据记录
如果设置的是TCaplusValueFlag_ALLOLDVALUE, 则操作成功后不返回数据
8. TCAPLUS_API_LIST_DELETE_REQ
如果设置的是TCaplusValueFlag_NOVALUE, 则操作成功后不返回数据
如果设置的是TCaplusValueFlag_SAMEWITHREQUEST, 则操作成功后返回和请求一致的数据, 暂时没有实现
如果设置的是TCaplusValueFlag_ALLVALUE, 则操作成功后返回空数据
如果设置的是TCaplusValueFlag_ALLOLDVALUE, 则操作成功后返回tcapsvr端listdelete前的数据
9. TCAPLUS_API_LIST_REPLACE_REQ
如果设置的是TCaplusValueFlag_NOVALUE, 则操作成功后不返回数据
如果设置的是TCaplusValueFlag_SAMEWITHREQUEST, 则操作成功后返回和请求一致的数据, 暂时没有实现
如果设置的是TCaplusValueFlag_ALLVALUE, 则操作成功后返回tcapsvr端listreplace后的数据
如果设置的是TCaplusValueFlag_ALLOLDVALUE, 则操作成功后返回tcapsvr端listreplace前的数据
10. TCAPLUS_API_LIST_REPLACE_BATCH_REQ
如果设置的是TCaplusValueFlag_NOVALUE, 操作成功后返回和请求一致的数据
如果设置的是TCaplusValueFlag_SAMEWITHREQUEST, 则操作成功后返回和请求一致的数据
如果设置的是TCaplusValueFlag_ALLVALUE, 则操作成功后返回tcapsvr端listreplace后的数据
如果设置的是TCaplusValueFlag_ALLOLDVALUE, 则操作成功后返回tcapsvr端listreplace前的数据
@param [IN] result_flag 请求标志:
0表示: 只需返回操作执行成功与否
1表示: 返回与请求字段一致
2表示: 须返回变更记录的所有字段最新数据
3表示: 须返回变更记录的所有字段旧数据
从而知道是哪个key对应的记录失败了
@retval 0 设置成功
@retval <0 失败，返回对应的错误码。通常因为未初始化。
*/
SetResultFlagForSuccess(result_flag byte) int
/**
@brief 设置响应标志。主要是本次请求执行失败后返回给前端的数据
result_flag 的取值范围如下:
TCaplusValueFlag_NOVALUE = 0, // 不返回任何返回值
TCaplusValueFlag_SAMEWITHREQUEST = 1, // 返回同请求一致的值
TCaplusValueFlag_ALLVALUE = 2, // 返回tcapsvr端操作后所有字段的值
TCaplusValueFlag_ALLOLDVALUE = 3, // 返回tcapsvr端操作前所有字段的值
下面是各个支持的命令字在设置不同的result_flag下执行失败后返回给API端的数据详细情况:
1. TCAPLUS_API_INSERT_REQ TCAPLUS_API_BATCH_INSERT_REQ
如果设置的是TCaplusValueFlag_NOVALUE, 则操作失败后不返回数据
如果设置的是TCaplusValueFlag_SAMEWITHREQUEST, 则操作失败后返回和请求一致的数据
如果设置的是TCaplusValueFlag_ALLVALUE, 不合理场景
如果设置的是TCaplusValueFlag_ALLOLDVALUE, 如果获取到了tcapsvr端的数据则返回tcpasvr端的数据,如果没有获取到tcapsvr端的数据则返回空
2. TCAPLUS_API_REPLACE_REQ TCAPLUS_API_BATCH_REPLACE_REQ
如果设置的是TCaplusValueFlag_NOVALUE, 则操作失败后不返回数据
如果设置的是TCaplusValueFlag_SAMEWITHREQUEST, 则操作失败后返回和请求一致的数据
如果设置的是TCaplusValueFlag_ALLVALUE, 不合理场景
如果设置的是TCaplusValueFlag_ALLOLDVALUE, 如果获取到了tcapsvr端的数据则返回tcpasvr端的数据,如果没有获取到tcapsvr端的数据则返回空
3. TCAPLUS_API_UPDATE_REQ TCAPLUS_API_BATCH_UPDATE_REQ
如果设置的是TCaplusValueFlag_NOVALUE, 则操作失败后不返回数据
如果设置的是TCaplusValueFlag_SAMEWITHREQUEST, 则操作失败后返回和请求一致的数据
如果设置的是TCaplusValueFlag_ALLVALUE, 不合理场景
如果设置的是TCaplusValueFlag_ALLOLDVALUE, 如果获取到了tcapsvr端的数据则返回tcpasvr端的数据,如果没有获取到tcapsvr端的数据则返回空
4. TCAPLUS_API_INCREASE_REQ
如果设置的是TCaplusValueFlag_NOVALUE, 则操作失败后不返回数据
如果设置的是TCaplusValueFlag_SAMEWITHREQUEST, 则操作失败后返回和请求一致的数据
如果设置的是TCaplusValueFlag_ALLVALUE, 不合理场景
如果设置的是TCaplusValueFlag_ALLOLDVALUE, 如果获取到了tcapsvr端的数据则返回tcpasvr端的数据,如果没有获取到tcapsvr端的数据则返回空
5. TCAPLUS_API_DELETE_REQ TCAPLUS_API_BATCH_DELETE_REQ
如果设置的是TCaplusValueFlag_NOVALUE, 则操作失败后不返回数据
如果设置的是TCaplusValueFlag_SAMEWITHREQUEST, 则操作失败后返回和请求一致的数据
如果设置的是TCaplusValueFlag_ALLVALUE, 不合理场景
如果设置的是TCaplusValueFlag_ALLOLDVALUE, 如果获取到了tcapsvr端的数据则返回tcpasvr端的数据,如果没有获取到tcapsvr端的数据则返回空
6. TCAPLUS_API_LIST_DELETE_BATCH_REQ
如果设置的是TCaplusValueFlag_NOVALUE, 则操作失败后不返回数据
如果设置的是TCaplusValueFlag_SAMEWITHREQUEST, 则操作失败后返回和请求一致的数据, 暂时没有实现
如果设置的是TCaplusValueFlag_ALLVALUE, 不合理场景
如果设置的是TCaplusValueFlag_ALLOLDVALUE, 则操作成功后返回tcapsvr端操作前的数据, 凡是本次成功删除的index对应的数据都会返回
7. TCAPLUS_API_LIST_ADDAFTER_REQ
如果设置的是TCaplusValueFlag_NOVALUE, 则操作失败后不返回数据
如果设置的是TCaplusValueFlag_SAMEWITHREQUEST, 则操作失败后返回和请求一致的数据, 暂时没有实现
如果设置的是TCaplusValueFlag_ALLVALUE, 不合理场景
如果设置的是TCaplusValueFlag_ALLOLDVALUE, 不返回数据
8. TCAPLUS_API_LIST_DELETE_REQ
如果设置的是TCaplusValueFlag_NOVALUE, 则操作失败后不返回数据
如果设置的是TCaplusValueFlag_SAMEWITHREQUEST, 则操作失败后返回和请求一致的数据, 暂时没有实现
如果设置的是TCaplusValueFlag_ALLVALUE, 不合理场景
如果设置的是TCaplusValueFlag_ALLOLDVALUE, 如果获取到了tcapsvr端的数据则返回tcpasvr端的数据,如果没有获取到tcapsvr端的数据则返回空
9. TCAPLUS_API_LIST_REPLACE_REQ
如果设置的是TCaplusValueFlag_NOVALUE, 则操作失败后不返回数据
如果设置的是TCaplusValueFlag_SAMEWITHREQUEST, 则操作失败后返回和请求一致的数据, 暂时没有实现
如果设置的是TCaplusValueFlag_ALLVALUE, 不合理场景
如果设置的是TCaplusValueFlag_ALLOLDVALUE, 如果获取到了tcapsvr端的数据则返回tcpasvr端的数据,如果没有获取到tcapsvr端的数据则返回空
@param [IN] result_flag 请求标志:
0表示: 只需返回操作执行成功与否
1表示: 返回与请求字段一致
2表示: 须返回变更记录的所有字段最新数据
3表示: 须返回变更记录的所有字段旧数据
对于batch_get请求，该字段设置为大于0时，某个key查询记录不存在或svr端产生的其它错误时会返回对应的key，
从而知道是哪个key对应的记录失败了
@retval 0 设置成功
@retval <0 失败，返回对应的错误码。通常因为未初始化。
*/
SetResultFlagForFail(result_flag byte) int
/**
@brief 设置是否允许一个请求包可以自动响应多个应答包，仅对ListGetAll和BatchGet协议有效。
@param [IN] multi_flag 多响应包标示，1表示允许一个请求包可以自动响应多个应答包,
0表示不允许一个请求包自动响应多个应答包
@retval 0 设置成功
@retval <0 设置失败，具体错误参见 \link ErrorCode \endlink
@note 分包应答，目前只支持ListGetAll和BatchGet操作；其他操作设置该值是没有意义的，
函数会返回<0的错误码。
*/
SetMultiResponseFlag(multi_flag byte) int32
6. 响应对象(response)中的方法说明
注：此处未列出的响应对象的其它方法，即表示该方法在查询数据的场景不需要使用，误用可能会导致报错。
/*
@brief 获取响应结果
@retval int tcaplus api自定义错误码。 0，表示请求成功；非0,有错误码，可从terror.GetErrMsg(int)得到错误消息
*/
GetResult() int
/*
@brief 获取响应表名
@retval string 响应消息对应的表名称
*/
GetTableName() string
/*
@brief 获取响应appId
@retval uint64 响应消息对应的appId
*/
GetAppId() uint64
/*
@brief 获取响应zoneId
@retval uint32 响应消息对应的zoneId
*/
GetZoneId() uint32
/*
@brief 获取响应命令
@retval int 响应消息命令字，cmd包中的响应命令字
*/
GetCmd() int
/*
@brief 获取响应异步id，和请求对应
@retval uint64 响应消息对应的异步id和请求对应
*/
GetAsyncId() uint64
/*
@brief 获取本响应中结果记录条数
@retval int 响应中结果记录条数
*/
GetRecordCount() int
/*
@brief 从结果中获取一条记录
@retval *record.Record 记录指针
@retval error 错误码
*/
FetchRecord() (*record.Record, error)
/*
@brief 获取响应消息中的用户缓存信息
@retval []byte 用户缓存二进制，和请求消息中的buffer内容一致
*/
GetUserBuffer() []byte
/*
@判断是否有更多的回包
@retval 1 有， 0 没有
*/
HaveMoreResPkgs() int
7. 记录对象(record)中的方法说明
注：此处未列出的响应对象的其它方法，即表示该方法在查询数据的场景不需要使用，误用可能会导致报错。
- record的通用方法：
/**
@brief 获取记录版本号
@retval 记录版本号
@note 对于Generic操作表示获取Record的版本；对于List操作表示获取Record所在List的版本。
**/
func (r *Record) GetVersion() int32
/**
@brief 设置记录版本号
@param [IN] v 数据记录的版本号: <=0 表示不关注版本号不关心版本号。具体含义如下。
当CHECKDATAVERSION_AUTOINCREASE时: 表示检测记录版本号。
如果Version的值<=0,则仍然表示不关心版本号不关注版本号；
如果Version的值>0，那么只有当该版本号与服务器端的版本号相同时，
Replace, Update, Increase, ListAddAfter, ListDelete, ListReplace, ListDeleteBatch操作才会成功同时在服务器端该版本号会自增1。
当NOCHECKDATAVERSION_OVERWRITE时: 表示不检测记录版本号。
如果Version的值<=0,则会把版本号1写入服务端的数据记录版本号(服务器端成功写入的数据记录的版本号最少为1)；
如果Version的值>0，那么会把该版本号写入服务端的数据记录版本号。
当NOCHECKDATAVERSION_AUTOINCREASE时: 表示不检测记录版本号，将服务器端的数据记录版本号自增1，若服务器端新写入数据记录则新写入的数据记录的版本号为1。
**/
func (r *Record) SetVersion(v int32)
/**
@brief 基于 PB Message 设置record数据
@param [IN] data PB Message
@retval []byte 记录的keybuf，用来唯一确定一条记录，多用于请求与响应记录相对应
@retval error 错误码
*/
func (r *Record) SetPBData(message proto.Message) ([]byte, error)
/**
@brief 基于 PB Message 读取record数据
@param [IN] data PB Message
@retval []byte 记录的keybuf，用来唯一确定一条记录，多用于请求与响应记录相对应
@retval error 错误码
**/
func (r *Record) GetPBData(message proto.Message) error
/**
@brief 设置部分value字段，专用于field操作，TcaplusApiPBFieldGetReq TcaplusApiPBFieldUpdateReq TcaplusApiPBFieldIncreaseReq
@param [IN] msg proto.Message 由proto文件生成的记录结构体
@param [IN] values []string 指定本次设置的 value 字段
@retval []byte 由记录key字段编码生成，由于多条记录的响应记录是无序的，可以用这个值来匹配记录
@retval error 错误码
**/
func (r *Record) SetPBFieldValues(message proto.Message, values []string) ([]byte, error)
/**
@brief 设置部分key字段，专用于partkey操作，TcaplusApiGetByPartkeyReq
@param [IN] msg proto.Message 由proto文件生成的记录结构体
@param [IN] keys []string 指定本次设置的 key 字段
@retval []byte 由记录key字段编码生成，由于多条记录的响应记录是无序的，可以用这个值来匹配记录
@retval error 错误码
**/
func (r *Record) SetPBPartKeys(message proto.Message, keys []string) ([]byte, error)
8. 常见问题
详见错误码含义和处理方法。